Get information about an order of promo codes

This request is used to get detailed information about the order.

Request syntax

GET https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/info?order_id={order ID}

Request headers

Authorization: Bearer <OAuth-token>
OAuth access token. The steps to get a token are described in Getting started.

X-YaTaxi-Selected-Corp-Client-Id — client ID from the account. Required if multiple clients are available using the token.

Request parameters

The request contains a required parameter:

order_id: The order ID.

Response field description

The response contains the following fields:

Field	Description	Format
`active_until`	Promo code expiration date.	String
`count`	Number of promo codes in a series.	Number
`order_id`	The order ID.	String
`pricing`	Detailed pricing information.	Object
`service`	A service where you can apply promo codes.	String
`status`	The order status.	String
`value`	Value of a single promo code.	Number
`revoke_count`	Number of revoked promo codes in the order.	Number
`classes`	The list of service classes covered by a promo code.	Array of strings
`geo_restrictions`	Information about geo restrictions.	Array of objects

Structure of the pricing object:

Field	Description	Format
`cost`	Cost.	Number
`cost_with_vat`	Cost with VAT.	Number
`currency`	Currency.	String
`vat`	VAT value.	Number

Structure of the geo_restrictions array elements:

Field	Description	Format
`destination`	Geo restrictions of the destination.	Object
`source`	Geo restrictions of the departure point.	Object
`max_intermediate_points`	The maximum number of intermediate points.	Number

Structure of the destination and source objects:

Field	Description	Format
`corp_geo_id`	Restriction region ID.	String
`geo`	Geo data.	Object
`name`	Restriction region name.	String

Structure of the geo object:

Field	Description	Format
`center`	Coordinates of the region center.	Array
`radius`	The radius of the region with a `center` point where restrictions apply. Specified in meters.	Number

Request example

POST https://b2b-api.go.yandex.ru/integration/2.0/promocodes/orders/info?order_id=017...5dd
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Response example

{
  "active_until": "2024-12-31",
  "count": 30,
  "geo_restrictions": [
    {
      "destination": {
        "corp_geo_id": "91d...a3c",
        "geo": {
          "center": [ 55.754572, 37.621182 ],
          "radius": 200
        },
        "name": "Finish"
      },
      "max_intermediate_points": 2,
      "source": {
        "corp_geo_id": "be9...d4a",
        "geo": {
          "center": [ 55.754572, 37.621182 ],
          "radius": 200
        },
        "name": "Start"
      }
    }
  ],
  "order_id": "017...5dd",
  "pricing": {
    "cost": "6600.00",
    "cost_with_vat": "7920.00",
    "currency": "RUB",
    "vat": "0.20"
  },
  "service": "taxi",
  "status": "creation_success",
  "value": 220,
  "revoke_count": 0
}

Response codes

The response to this request can contain the following standard HTTP codes:

200: Request completed successfully.
400: An unknown parameter or a parameter with an invalid value was passed in the request.
403:
- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header X-YaTaxi-Selected-Corp-Client-Id (returned if more than one client is available for the token).
- SELECTED_CLIENT_ACCESS_DENIED: the header X-YaTaxi-Selected-Corp-Client-Id contains the client's ID, which this login does not have access to.
404: Order not found.

Was the article helpful?

List of promo codes in the order

Get information about the planned ride